<?php
/**
 * Ruth Library
 * $Id: Syck.php 2 2008-01-17 02:59:56Z baron314159@yahoo.com $
 *
 * LICENSE
 *
 * Copyright (c) 2007, Chris Utz
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the Impact Lab nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY CHRIS UTZ ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL CHRIS UTZ BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * @category   Ruth
 * @package    Ruth_Message
 * @author     Chris Utz <chris@chrisutz.com>
 * @copyright  2007 Chris Utz <chris@chrisutz.com>
 * @license    http://www.opensource.org/licenses/bsd-license.php    New BSD License
 * @version    $Revision: 2 $
 */

/**
 * @see Ruth_Message_Catalog
 */
require_once 'Ruth/Message/Catalog.php';

/**
 * @see Ruth_Message_Exception
 */
require_once 'Ruth/Message/Exception.php';

/**
 * 
 *
 * @category   Ruth
 * @package    Ruth_Message
 * @subpackage Ruth_Message_Catalog
 * @author     Chris Utz <chris@chrisutz.com>
 * @copyright  2007 Chris Utz <chris@chrisutz.com>
 * @license    http://www.opensource.org/licenses/bsd-license.php    New BSD License
 * @version    $Revision: 2 $
 */
class Ruth_Message_Catalog_Syck extends Ruth_Message_Catalog
{
    /**
     * Constructs a Ruth_Message_Catalog_Syck object, optionally
     * loading the message tables from a YAML file.
     *
     * @param string|null $yamlPathName An optional path to a YAML file
     * @return void
     * @throws Ruth_Message_Exception
     */
    public function __construct($yamlPathName = null)
    {
        if (null !== $yamlPathName) {
            $this->setTablesFromYamlFile($yamlPathName);
        }
    }

    /**
     * Loads the message tables from a string of YAML code.
     * 
     * @param string $yaml A string containing message tables marked up with YAML
     * @throws Ruth_Message_Exception
     */
    public function setTablesFromYaml($yaml)
    {
        if (!function_exists('syck_load')) {
            throw new Ruth_Message_Exception("the syck extension must be "
                . "installed in order to use the Ruth_Message_Catalog_Syck class");
        }

        try {
            $tables = syck_load($yaml);

            if (!is_array($tables)) {
                $tables = array();
            }
        } catch (SyckException $e) {
            throw new Ruth_Message_Exception('rethrown SyckException: ' . $e->getMessage());
        }

        $this->setTables($tables);
    }

    /**
     * Loads the message tables from a file of YAML code.
     * 
     * @param string $yamlPathName A path to a YAML file
     * @throws Ruth_Message_Exception
     */
    public function setTablesFromYamlFile($yamlPathName)
    {
        $yaml = file_get_contents($yamlPathName);

        if (false === $yaml) {
            throw new Ruth_Message_Exception("file_get_contents failed on file {$yamlPathName}");
        }

        $this->setTablesFromYaml($yaml);
    }
}
 
// vim: sw=4:ts=4:sts=4:et
